docs: document v2.0 manifest contract#370
Open
atilafassina wants to merge 1 commit into
Open
Conversation
Add docs/docs/plugins/manifest.md covering the v2.0 plugin manifest: resources, kind/cli discovery descriptors, field dependencies, and post-scaffold steps. Update templates.md to cover the v2.0 template manifest: computed `origin` field, `scaffolding` descriptor, and postScaffold propagation. Update custom-plugins.md to recommend the manifest.json import pattern matching the core plugins. Co-authored-by: Isaac Signed-off-by: Atila Fassina <atila@fassina.eu>
atilafassina
requested review from
Copilot and
pkosiec
and removed request for
a team
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the AppKit plugin manifest v2.0 contract and how it propagates into the synced template manifest used by databricks apps init, giving plugin authors a single reference for resources, discovery, and post-scaffold guidance.
Changes:
- Added a new “Plugin manifest” reference page covering v2.0 fields, resource permissions, discovery descriptors, dependency ordering, and post-scaffold steps.
- Updated the templates documentation to describe v2.0 synced-manifest additions (
origin,scaffolding,postScaffoldpropagation). - Updated the custom plugins guide to recommend importing
manifest.jsonand attaching it viastatic manifest(matching core plugin patterns).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/docs/plugins/manifest.md | New v2.0 plugin manifest contract reference (resources, discovery, dependencies, post-scaffold, optional metadata). |
| docs/docs/plugins/custom-plugins.md | Updates basic example to use JSON-authored manifests imported into the plugin class. |
| docs/docs/development/templates.md | Documents v2.0 additions to the synced template manifest (origin, scaffolding, and postScaffold propagation). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The synced manifest is generated by `appkit plugin sync --write` from each plugin's `manifest.json` (see [Plugin manifest](../plugins/manifest.md) for the authoring contract). The on-disk shape carries a `version` field that the CLI uses to negotiate features: | ||
|
|
||
| - `"1.0"` / `"1.1"` — earlier shapes; still readable. | ||
| - `"2.0"` — current shape. Adds `scaffolding` (required) and the `origin` field on every resource field entry. JSON Schema published at `https://databricks.github.io/appkit/schemas/template-plugins.schema.json`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #261. Documents the v2.0 plugin manifest contract introduced there.
Summary
docs/docs/plugins/manifest.md— full v2.0 manifest reference: resources (per-type permissions),kind/clidiscovery descriptors,dependsOnfield ordering, post-scaffold steps, optional metadata.docs/docs/development/templates.md— covers the synced template manifest's v2.0 additions: computedoriginfield (with precedence rules),scaffoldingdescriptor (command + flags +never/mustrules),postScaffoldpropagation.docs/docs/plugins/custom-plugins.md— recommends theimport manifest from "./manifest.json"+static manifestpattern that all core plugins use, with a JSON-side example.No code changes — docs only. Stacked-PR base will flip to
mainonce #261 lands.Test plan
pnpm docs:build— Docusaurus production build passes, no broken links.pnpm check:fix— Biome clean.pnpm -r typecheck— clean across all packages (docs included).This pull request and its description were written by Isaac.